POST api/channel/{authenticationToken}

This method will return a list of business channels defined in Epic based on the criteria passed in.

Request Information

URI Parameters

Name	Description	Type	Additional information
authenticationToken	Current authentication token	string	Required

Body Parameters

This determines the type of channels to return and also determines if only active channels should be returned.

ChannelCriteriaModel

Name	Description	Type	Additional information
WantActiveOnly	This property indicates whether only active business channels should be returned or if all business channels should be returned.	boolean	None.
ChannelType	This property is the desired channel type for getting a list of business channels. Valid channel types are Retail, Wholesale, Correspondent, Consumer, and Commercial. If nothing is passed in, then all channel types will be returned.	string	None.

Request Formats

application/json, text/json

Sample:

{
  "WantActiveOnly": true,
  "ChannelType": "sample string 2"
}

application/xml, text/xml

Sample:

<ChannelCriteriaModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EpicAPI.Models">
  <ChannelType>sample string 2</ChannelType>
  <WantActiveOnly>true</WantActiveOnly>
</ChannelCriteriaModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of ChannelModel

Name	Description	Type	Additional information
ChannelKey	This is the identifier for the business channel.	string	None.
Alias	This is the business channel alias.	string	None.
Description	This is the description for the business channel.	string	None.
IsEmployeeChannel	Is this business channel for employees only?	boolean	None.
IsActive	Is this business channel currently active?	boolean	None.
IsRetail	Is this a retail mortgage business channel?	boolean	None.
IsWholesale	Is this a wholesale mortgage business channel?	boolean	None.
IsCommercial	Is this a commercial loan business channel?	boolean	None.
IsConsumer	Is this a consumer loan business channel?	boolean	None.
IsCorrespondent	Is this a correspondent business channel?	boolean	None.
IsRealEstate	Is this business channel being used for a real estate transaction?	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ChannelKey": "sample string 1",
    "Alias": "sample string 2",
    "Description": "sample string 3",
    "IsEmployeeChannel": true,
    "IsActive": true,
    "IsRetail": true,
    "IsWholesale": true,
    "IsCommercial": true,
    "IsConsumer": true,
    "IsCorrespondent": true,
    "IsRealEstate": true
  },
  {
    "ChannelKey": "sample string 1",
    "Alias": "sample string 2",
    "Description": "sample string 3",
    "IsEmployeeChannel": true,
    "IsActive": true,
    "IsRetail": true,
    "IsWholesale": true,
    "IsCommercial": true,
    "IsConsumer": true,
    "IsCorrespondent": true,
    "IsRealEstate": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfChannelModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EpicAPI.Models">
  <ChannelModel>
    <Alias>sample string 2</Alias>
    <ChannelKey>sample string 1</ChannelKey>
    <Description>sample string 3</Description>
    <IsActive>true</IsActive>
    <IsCommercial>true</IsCommercial>
    <IsConsumer>true</IsConsumer>
    <IsCorrespondent>true</IsCorrespondent>
    <IsEmployeeChannel>true</IsEmployeeChannel>
    <IsRealEstate>true</IsRealEstate>
    <IsRetail>true</IsRetail>
    <IsWholesale>true</IsWholesale>
  </ChannelModel>
  <ChannelModel>
    <Alias>sample string 2</Alias>
    <ChannelKey>sample string 1</ChannelKey>
    <Description>sample string 3</Description>
    <IsActive>true</IsActive>
    <IsCommercial>true</IsCommercial>
    <IsConsumer>true</IsConsumer>
    <IsCorrespondent>true</IsCorrespondent>
    <IsEmployeeChannel>true</IsEmployeeChannel>
    <IsRealEstate>true</IsRealEstate>
    <IsRetail>true</IsRetail>
    <IsWholesale>true</IsWholesale>
  </ChannelModel>
</ArrayOfChannelModel>